Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lint: help beginners to figure out what MISSING LICENSES means #812

Closed
wants to merge 1 commit into from

Conversation

jfilak
Copy link

@jfilak jfilak commented Jul 28, 2023

I spent around 50minutes debugging and reading the source codes to find out that you the reuse tool expects texts of licenses in the directory LICENSES.

This commit adds a hint message for slower people like me.

From:

 # MISSING LICENSES

'CC-BY-4.0' found in:
* CONTRIBUTING.md
* README.md

 # SUMMARY

* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: CC-BY-4.0
* Unused licenses: 0
* Used licenses: CC-BY-4.0
* Read errors: 0
* files with copyright information: 2 / 2
* files with license information: 2 / 2

Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(

To:

 # MISSING LICENSES
The corresponding license txt files were not found in the directory LICENSES

'CC-BY-4.0' found in:
* CONTRIBUTING.md
* README.md

 # SUMMARY

* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: CC-BY-4.0
* Unused licenses: 0
* Used licenses: CC-BY-4.0
* Read errors: 0
* files with copyright information: 2 / 2
* files with license information: 2 / 2

Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(

I spent around 50minutes debugging and reading the source codes to find out
that you the reuse tool expects texts of licenses in the directory LICENSES.

This commit adds a hint message for slower people like me.

From:
```
 # MISSING LICENSES

'CC-BY-4.0' found in:
* CONTRIBUTING.md
* README.md

 # SUMMARY

* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: CC-BY-4.0
* Unused licenses: 0
* Used licenses: CC-BY-4.0
* Read errors: 0
* files with copyright information: 2 / 2
* files with license information: 2 / 2

Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(
```

To:
```
 # MISSING LICENSES
The corresponding license txt files were not found in the directory LICENSES

'CC-BY-4.0' found in:
* CONTRIBUTING.md
* README.md

 # SUMMARY

* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: CC-BY-4.0
* Unused licenses: 0
* Used licenses: CC-BY-4.0
* Read errors: 0
* files with copyright information: 2 / 2
* files with license information: 2 / 2

Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(
```
@carmenbianca
Copy link
Member

Thanks for the contribution. I think this is related to #698. I'll find time for review later.

@mxmehl
Copy link
Member

mxmehl commented Jul 31, 2023

Thanks for the contribution. I think this is related to #698. I'll find time for review later.

Yes, please let's try to incorporate this PR finally, it would solve this issue entirely.

@carmenbianca
Copy link
Member

Fixed by #698. Thanks for the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants